home *** CD-ROM | disk | FTP | other *** search
/ PC World 2006 September / PCWorld_2006-09_cd.bin / v cisle / samurize / samurize_1.64.exe / MultimediaReadme.txt < prev    next >
Text File  |  2006-04-30  |  14KB  |  276 lines
  1. Spectrum Visualizations and Media Info for Samurize
  2. ===================================================
  3.  
  4. made by Tropics (samurize@only-tropics.de)
  5. idea by torsius
  6.  
  7.  
  8. General Notes
  9. -------------
  10. To use this plugin, you also need one of the  following
  11. Audio/Media Players installed:
  12. - WinAmp 2, 3 or 5
  13. - Quintessential Player (QCD) 4.11+
  14. - FooBar2000 0.9
  15. - Windows Media Player 9
  16. - iTunes 4
  17. Make sure the refresh rate and the number of spectrum bands
  18. you use in your Samurize config file are the same as in
  19. the Media Player plugin you use. Anything else would only
  20. degrade performance.
  21. This plugin pack is part of the Samurize Distribution,
  22. so get updates via http://www.samurize.com.
  23.  
  24.  
  25. Samurize
  26. --------
  27. The plugin files are SpectrumVis.dll and 
  28. AdvancedMediaPlayerInfo.dll and they should already be in your 
  29. Samurize/plugins directory. The AdvancedMediaPlayerInfo plugin
  30. works only with QCD, FooBar2000, Windows Media Player,
  31. WinAmp 5 and iTunes. The Spectrum plugin works with QCD, 
  32. FooBar2000, iTunes and WinAmp 2/3/5.
  33. Two config files are included for reference, spectrum_vis.ini 
  34. and advmediainfo.ini. The first one is a 18-band spectrum 
  35. analyser, the second one displays advanced track info.
  36.  
  37.  
  38. WinAmp 2/5
  39. ----------
  40. The spectrum plugin file is WinAmpSamurize.dll. It is installed by
  41. the Samurize installer in your Winamp/plugins directory.
  42. If it is not there, rerun the installer and make sure the
  43. plugin is installed.
  44. To run the plugin, start the plugin selection dialog by
  45. pressing CTRL-K and select it in the list. Start the
  46. plugin with CTRL-SHIFT-K.
  47. The plugin has to be run manually every time you start
  48. WinAmp, or it can be automatically started if you select the
  49. option 'auto-execute visualization plug-in on play' under
  50. 'Plugins' in the Preferences dialog.
  51. An info plugin is also included, named gen_samurizeinfo.dll. 
  52. It should already be in your plugins
  53. directory. It is a general purpose plugin and should work
  54. out of the box. You don't have to activate it. See the sample 
  55. config advmediainfo.ini for info how to use. 
  56.  
  57.  
  58. Quintessential Player (QCD)
  59. ---------------------------
  60. The plugin files, QCDSamurizeInfo.dll and QCDSamurizeVis.dll, 
  61. should be in the /plugins subdirectory of your QCD installation.
  62. QCDSamurizeInfo.dll is a generic plugin, which can serve information
  63. about the currently playing track to Samurize. The sample config 
  64. file advmediainfo.ini demonstrates the use.
  65. The advanced media info plugin has a function 'getPlaylistString',
  66. which takes a 'Format' parameter. For QCD, this parameter has no
  67. use. The current track is returned as it is printed in the
  68. playlist. 
  69. QCDSamurizeVis is the visualization plugin which serves the spectrum
  70. data. For this to work a QCD Visualization Window has to be
  71. visible, and the plugin has to be selected there. It renders a 
  72. Samurize Logo there then. A minimized player will disable the plugin.
  73. The plugins require QCD 4.11 or above.
  74.  
  75.  
  76. FooBar2000
  77. ----------
  78. The plugin files are foo_info_samurize.dll and foo_vis_samurize2.dll. 
  79. The Samurize installer should have put it in the /components 
  80. subdirectory of your FooBar installation folder.
  81. The advanced media info plugin has a function 'NativePlaylistString',
  82. which takes a 'Format' parameter. It uses the same formatting language
  83. as all of foobars title formatting options. If you never used that,
  84. "%artist% - [%album% / ]%title%" (without the quotes) might be a good
  85. starting point. See foobars help for more info on that language.
  86. Both the formatting parameter and the result string are truncated
  87. to 1024 characters.
  88. For the spectrum visualization, open the Preferences dialog and make 
  89. sure that the visualizations are enabled. The plugin configuration 
  90. should already be available as a subitem there.
  91. The plugin works with FooBar2000 0.9+. 
  92.  
  93.  
  94. Windows Media Player
  95. --------------------
  96. The info plugin file is WM9SamurizeInfo.dll. It should be where the
  97. wmplayer.exe is - normally c:\program files\windows media player.
  98. When the Player is running and the info plugin is activated, there is
  99. a small green icon on the right side of the track title, indicating
  100. that a background plugin is running. If it is not, go to options->plugins
  101. and make sure it is listed and activated.
  102.  
  103.  
  104. iTunes
  105. ------
  106. The info plugin file is iTunesSamurizeInfo.dll, it should already be in
  107. the "plug-ins" subdirectory of your iTunes installation. Although it is
  108. a visual plugin, it does not need to be active to serve the data to
  109. Samurize if you are using the AdvancedMediaPlayerInfo part. 
  110. If you want to use the spectrum, you must activate the plugin via menu
  111. or Ctrl-T.
  112.  
  113.  
  114. Advanced Media Info functions getPlaylistString + PlaylistString_Rotate
  115. =======================================================================
  116. The following replace pattern applys:
  117.  
  118. Pattern   is replaced with                              QCD WA5 iTu WMP FoB
  119. ---------------------------------------------------------------------------
  120. %b        line break                                     +   +   +   +   +
  121. %tab      tabulator                                      +   +   +   +   +
  122. %[        begin condition                                +   +   +   +   +
  123. %]        end condition                                  +   +   +   +   +
  124. ---------------------------------------------------------------------------
  125. %wp       Track title (as it appears in a playlist)      +   +   -   +   o
  126. %wt       Track info (playlist number, title & artist)   +   +   +   +   +
  127. %min      Minutes component of song length               +   +   +   +   +
  128. %sec      Seconds component of song length (two digits)  +   +   +   +   +
  129. %pm       Current song position (minutes)                +   +   o   +   +
  130. %ps       Current song position (seconds, two digits)    +   +   o   +   +
  131. %prc      Percentage played of current song              +   +   o   +   +
  132. %sr       Song sample rate (eg. 44 kHz)                  +   +   -   -   +
  133. %r        Song bitrate (eg. 128 kbps)                    +   +   +   +   +
  134. %pl       Playlist length (number of tracks)             +   +   -   +   +
  135. %pp       Position of current song in playlist           +   +   -   +   +
  136. %ch       Song channel (Stereo or Mono)                  +   +   -   -   +
  137. %f        Full path to currently playing file            +   +   +   +   +
  138. ---------------------------------------------------------------------------
  139. %t        Track title                                    +   +   +   +   +
  140. %ar       Track artist                                   +   +   +   +   +
  141. %c        Track comment                                  -   +   +   -   -
  142. %al       Track album                                    +   +   +   +   +
  143. %y        Track year                                     -   +   +   +   +
  144. %g        Track genre                                    -   +   +   +   +
  145. %nt       Track number                                   +   -   -   -   +
  146. %cmp      Composer                                       -   -   -   +   +
  147. %e        Encoder                                        -   -   -   -   +
  148. %u        URL                                            -   -   -   o   +
  149. %cpr      Copyright                                      -   -   -   +   +
  150. %oa       Original artist                                -   -   -   +   +
  151.  
  152. +  Feature is implemented and seems to return the correct value.
  153. o  Feature is unreliable or seems to return bogus information. The plugin
  154.    will try to fill in information but it might not be correct.
  155. -  Feature is not supported by the player. The plugin will replace that
  156.    pattern with an empty string.
  157.    
  158. Conditions
  159. ----------
  160. Allows you to skip parts of the pattern if a tag doesn't exist. For example,
  161. %[Album: %al%] does evaluate to an empty string if the currently playing
  162. song does not contain a valid album tag.
  163. Unlimited nesting levels are supported.
  164.    
  165.    
  166. NativePlaylistString
  167. ====================
  168. Unlike previous versions, getPlaylistString does no longer allow to
  169. use the players native formatting language (like foobar). Use this
  170. function instead. Consult the foobar webpage for more info
  171. on that language and examples.
  172.  
  173.    
  174. Album Covers
  175. ============
  176. The file AdvancedMediaPlayerInfo.opt should be in your plugins directory.
  177. You can open it with any text editor (like notepad) to edit your options.
  178.  
  179. Options in [AlbumCover]
  180. -----------------------
  181. not_available: Specify the full path to a png file that should be displayed
  182.   when no album cover could be found.
  183. no_player_running: Specify the full path to a png file that should be
  184.   displayed when no supported audio player is running.
  185. downloading: Specify the full path to a png file that should be displayed
  186.   while the download background process is running.
  187. stream: Specify the full path to a png file that should be displayed
  188.   when playing a livestream for which no ip-dependend image file could
  189.   be found.
  190. global_dir: Specify a path where covers should be searched. It is created
  191.   if it doesn't exist
  192. independent_name: Set to 1 if you want the tag-independent search for
  193.   image files, 0 to disable. See below for details.
  194. autodownload_byalbum: Set to 1 to allow searching the internet for album
  195.   covers using the <album> tag, 0 to disable.
  196. album_skip_words: A list of words, seperated by spaces. When searching
  197.   by album, these words are removed from the query.
  198. autodownload_bytitle: Set to 1 to allow searching the internet for album
  199.   covers using the <title> tag, 0 to disable.
  200. title_skip_words: A list of words, seperated by spaces. When searching
  201.   by title, these words are removed from the query.
  202. linkage: 0, 1 or 2 dependend on the type of meter linkage you want to use.
  203.   0 will never create a meter link
  204.   1 will create a link to the local image file
  205.   2 will create a link to the amazon page for the album
  206.   note that for the images not_available, no_player_running, downloading
  207.   and stream a link is never returned.
  208. download_size: 0, 1 or 2 dependend on the image quality you want. Smaller
  209.   images have less quality, but also need less bandwidth to download.
  210.   0 small images (thumbnails)
  211.   1 medium images
  212.   2 large images
  213. check_online: 0, 1 or 2
  214.   0 do not check online status (always online)
  215.   1 check for existing ras connections (for modem, cable, dsl)
  216.   2 check via ping www.google.com
  217.  
  218. Exclusion list
  219. --------------
  220. The section [Files] defines an exclusion list. You can specify files or
  221. directory names here to have them excluded from one or more of the
  222. search tasks listed below. The matching is done via simple substring
  223. match, so parts of filenames will also work.
  224. The filename or substring is followed by a = sign and an exclusion id.
  225. The following exclusion ids are defined:
  226.     1: don't search for folder image
  227.     2: don't search for artist - title (local)
  228.     4: don't search for artist - album (local)
  229.     8: don't search for tag independent files
  230.    16: don't search the internet (by album)
  231.    32: don't search the internet (by title)
  232. You can use the sum of some values to exclude the file(s) from more than
  233. one search method. For example, use the id 48 to exclude a file from
  234. both internet download methods.
  235.  
  236. Search order
  237. ------------
  238. The currently playing song is analyzed. If its filename begins with http://
  239. it is a livestream. 
  240. When no extension is given in the following list, the search is
  241. done for jpg, png, gif and bmp files (in that order).
  242. Search order:
  243. - [Local Files only] The file "folder" is searched in the 
  244.   directory where the currently playing file is. 
  245.   This step is skipped for iTunes which does not serve sufficient
  246.   information.  
  247. - The file "<artist tag> - <title tag>" is searched in the current
  248.   directory, the directory above and the cover_global_dir directory.
  249. - The file "<artist tag> - <album tag>" is searched in the current
  250.   directory, the directory above and the global_dir directory.
  251. - [Local Files only] The current directory and the directory above
  252.   are searched for any image file, independent of the mp3 tags. This
  253.   is skipped if the independent_name option is set to 0.
  254.   If a filename contains "cover" or "front" it will be preferred.
  255.   This step is skipped for iTunes which does not serve sufficient
  256.   information.  
  257. - If the autodownload_byalbum option is set, the plugin searches 
  258.   www.amazon.com for an album cover using the album tag of the currently
  259.   playing file. If available, it is downloaded and saved as <album>.png 
  260.   in the global_dir directory. The feature obviously won't work if the 
  261.   playing file does not have a valid album tag.
  262. - If the autodownload_bytitle option is set, the plugin searches
  263.   www.amazon.com for an album cover using the title tag of the currently
  264.   playing file. This algorithm might find single covers for files not
  265.   covered by the above option, but it has also a much bigger propability
  266.   of downloading a cover which is not related to the file at all.
  267.   If available, the image is downloaded and saved as png file to the
  268.   global_dir directory.
  269. - [Livestream only] The ip adress of the livestream is taken, with the dots 
  270.   replaced by underscores. For the livestream url http://205.188.234.4:8028, 
  271.   the file "205_188_234_4" is searched in the directory specified 
  272.   in the global_dir option. 
  273. If none of the above methods do find a valid image, the file specified
  274. in the stream option is returned for livestreams, and the file specified
  275. in the not_available option is returned for local files.
  276.